home *** CD-ROM | disk | FTP | other *** search
/ Workbench Add-On / Workbench Add-On - Volume 1.iso / DiskUtil / Crunch / XFH / XSCAN / XSCAN.DOC < prev    next >
Encoding:
Text File  |  1994-05-06  |  2.3 KB  |  82 lines
  1.         xScan V1.2 - Manual
  2.  
  3.  
  4. NAME
  5.     C:xScan 
  6.  
  7. SYNOPSIS
  8.     xScan FILE/M/A,ALL/S,REMOVE/S
  9.  
  10. DESCRIPTION
  11.     xScan is a small CLI command which scans through XFH partition and
  12.     modifies them. After those modifications XFH (V1.34 or newer) will be
  13.     able to read directories MUCH faster. In fact you'll no more notice
  14.     a speed difference between XFH and the normal FileSystem.
  15.  
  16.     VERY IMPORTANT:
  17.     xScan will NOT work if you use it directly on a XFH partition, it'll
  18.     just do nothing. Instead of that you must use it on the PHYSICAL
  19.     directory of the XFH partition. E.g. if your XFH partition is called
  20.     "XH0:" and the rootdir of is "DH0:Archive", DON'T use "xScan XH0: ALL"
  21.     but "xScan DH0:Archive ALL".
  22.  
  23. THEORY
  24.     How does "xScan" work ?
  25.  
  26.     If XFH scans through a directory it opens EVERY file to check if it's
  27.     packed or not. That's why it's so slow.
  28.     xScan scan once through the directories for files. If it finds one
  29.     with an UNUSED filenote it adds a special one (filenote) to the file.
  30.     This filenote contains an ID string, some check values and the length
  31.     of the unpacked file(*).
  32.     If the new XFH scans through the directories it checks for such
  33.     filenotes and after finding one with still valid check values it'll
  34.     take the unpacked length from the filenote without opening the file.
  35.     That's why the new version is faster. Of course these special
  36.     filenotes will be hidden.
  37.  
  38.     (*) I don't want to explain the format exactly, because people
  39.         shouldn't use these informations.
  40.  
  41. ARGUMENTS
  42.     FILE:        You can supply as many files, directories or patterns
  43.             as you want.
  44.  
  45.     ALL:        scan through directory trees
  46.  
  47.     REMOVE:        remove filenotes instead of creating them
  48.  
  49.     Examples:
  50.  
  51.      xScan SYS:Archive/MetaFont ALL
  52.  
  53.     or
  54.  
  55.      xScan Docs/#?.doc REMOVE
  56.  
  57. HISTORY
  58.     1.0
  59.     - initial release for XFH 1.34
  60.  
  61.     1.1
  62.     - adds special filenotes to unpacked files, too
  63.  
  64.     1.2
  65.     - does NOT follow softlinks any more
  66.  
  67. COPYRIGHT
  68.     xScan is free to be spread on public-domain and shareware disks as
  69.     long as they are sold for a reasonable charge that is less than $6.
  70.     This applies not to Fred Fish, he and ONLY he can take more money.
  71.     For use in commercial products the permission of the author is
  72.     required.
  73.  
  74. AUTHOR
  75.     Matthias Scheler
  76.     Schützenstraße 18
  77.     33178 Borchen
  78.     Phone: +49-5251-399031
  79.  
  80.     InterNet: tron@lyssa.pb.owl.de
  81.     FidoNet:  Matthias Scheler 2:243/6310.10
  82.